home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / lib / python2.5 / email / quoprimime.pyc (.txt) < prev    next >
Python Compiled Bytecode  |  2008-10-29  |  9KB  |  289 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.5)
  3.  
  4. """Quoted-printable content transfer encoding per RFCs 2045-2047.
  5.  
  6. This module handles the content transfer encoding method defined in RFC 2045
  7. to encode US ASCII-like 8-bit data called `quoted-printable'.  It is used to
  8. safely encode text that is in a character set similar to the 7-bit US ASCII
  9. character set, but that includes some 8-bit characters that are normally not
  10. allowed in email bodies or headers.
  11.  
  12. Quoted-printable is very space-inefficient for encoding binary files; use the
  13. email.base64MIME module for that instead.
  14.  
  15. This module provides an interface to encode and decode both headers and bodies
  16. with quoted-printable encoding.
  17.  
  18. RFC 2045 defines a method for including character set information in an
  19. `encoded-word' in a header.  This method is commonly used for 8-bit real names
  20. in To:/From:/Cc: etc. fields, as well as Subject: lines.
  21.  
  22. This module does not do the line wrapping or end-of-line character
  23. conversion necessary for proper internationalized headers; it only
  24. does dumb encoding and decoding.  To deal with the various line
  25. wrapping issues, use the email.Header module.
  26. """
  27. __all__ = [
  28.     'body_decode',
  29.     'body_encode',
  30.     'body_quopri_check',
  31.     'body_quopri_len',
  32.     'decode',
  33.     'decodestring',
  34.     'encode',
  35.     'encodestring',
  36.     'header_decode',
  37.     'header_encode',
  38.     'header_quopri_check',
  39.     'header_quopri_len',
  40.     'quote',
  41.     'unquote']
  42. import re
  43. from string import hexdigits
  44. from email.utils import fix_eols
  45. CRLF = '\r\n'
  46. NL = '\n'
  47. MISC_LEN = 7
  48. hqre = re.compile('[^-a-zA-Z0-9!*+/ ]')
  49. bqre = re.compile('[^ !-<>-~\\t]')
  50.  
  51. def header_quopri_check(c):
  52.     '''Return True if the character should be escaped with header quopri.'''
  53.     return bool(hqre.match(c))
  54.  
  55.  
  56. def body_quopri_check(c):
  57.     '''Return True if the character should be escaped with body quopri.'''
  58.     return bool(bqre.match(c))
  59.  
  60.  
  61. def header_quopri_len(s):
  62.     '''Return the length of str when it is encoded with header quopri.'''
  63.     count = 0
  64.     for c in s:
  65.         if hqre.match(c):
  66.             count += 3
  67.             continue
  68.         count += 1
  69.     
  70.     return count
  71.  
  72.  
  73. def body_quopri_len(str):
  74.     '''Return the length of str when it is encoded with body quopri.'''
  75.     count = 0
  76.     for c in str:
  77.         if bqre.match(c):
  78.             count += 3
  79.             continue
  80.         count += 1
  81.     
  82.     return count
  83.  
  84.  
  85. def _max_append(L, s, maxlen, extra = ''):
  86.     if not L:
  87.         L.append(s.lstrip())
  88.     elif len(L[-1]) + len(s) <= maxlen:
  89.         L[-1] += extra + s
  90.     else:
  91.         L.append(s.lstrip())
  92.  
  93.  
  94. def unquote(s):
  95.     '''Turn a string in the form =AB to the ASCII character with value 0xab'''
  96.     return chr(int(s[1:3], 16))
  97.  
  98.  
  99. def quote(c):
  100.     return '=%02X' % ord(c)
  101.  
  102.  
  103. def header_encode(header, charset = 'iso-8859-1', keep_eols = False, maxlinelen = 76, eol = NL):
  104.     '''Encode a single header line with quoted-printable (like) encoding.
  105.  
  106.     Defined in RFC 2045, this `Q\' encoding is similar to quoted-printable, but
  107.     used specifically for email header fields to allow charsets with mostly 7
  108.     bit characters (and some 8 bit) to remain more or less readable in non-RFC
  109.     2045 aware mail clients.
  110.  
  111.     charset names the character set to use to encode the header.  It defaults
  112.     to iso-8859-1.
  113.  
  114.     The resulting string will be in the form:
  115.  
  116.     "=?charset?q?I_f=E2rt_in_your_g=E8n=E8ral_dire=E7tion?\\n
  117.       =?charset?q?Silly_=C8nglish_Kn=EEghts?="
  118.  
  119.     with each line wrapped safely at, at most, maxlinelen characters (defaults
  120.     to 76 characters).  If maxlinelen is None, the entire string is encoded in
  121.     one chunk with no splitting.
  122.  
  123.     End-of-line characters (\\r, \\n, \\r\\n) will be automatically converted
  124.     to the canonical email line separator \\r\\n unless the keep_eols
  125.     parameter is True (the default is False).
  126.  
  127.     Each line of the header will be terminated in the value of eol, which
  128.     defaults to "\\n".  Set this to "\\r\\n" if you are using the result of
  129.     this function directly in email.
  130.     '''
  131.     if not header:
  132.         return header
  133.     
  134.     if not keep_eols:
  135.         header = fix_eols(header)
  136.     
  137.     quoted = []
  138.     if maxlinelen is None:
  139.         max_encoded = 100000
  140.     else:
  141.         max_encoded = maxlinelen - len(charset) - MISC_LEN - 1
  142.     for c in header:
  143.         if c == ' ':
  144.             _max_append(quoted, '_', max_encoded)
  145.             continue
  146.         if not hqre.match(c):
  147.             _max_append(quoted, c, max_encoded)
  148.             continue
  149.         _max_append(quoted, '=%02X' % ord(c), max_encoded)
  150.     
  151.     joiner = eol + ' '
  152.     return []([ '=?%s?q?%s?=' % (charset, line) for line in quoted ])
  153.  
  154.  
  155. def encode(body, binary = False, maxlinelen = 76, eol = NL):
  156.     '''Encode with quoted-printable, wrapping at maxlinelen characters.
  157.  
  158.     If binary is False (the default), end-of-line characters will be converted
  159.     to the canonical email end-of-line sequence \\r\\n.  Otherwise they will
  160.     be left verbatim.
  161.  
  162.     Each line of encoded text will end with eol, which defaults to "\\n".  Set
  163.     this to "\\r\\n" if you will be using the result of this function directly
  164.     in an email.
  165.  
  166.     Each line will be wrapped at, at most, maxlinelen characters (defaults to
  167.     76 characters).  Long lines will have the `soft linefeed\' quoted-printable
  168.     character "=" appended to them, so the decoded text will be identical to
  169.     the original text.
  170.     '''
  171.     if not body:
  172.         return body
  173.     
  174.     if not binary:
  175.         body = fix_eols(body)
  176.     
  177.     encoded_body = ''
  178.     lineno = -1
  179.     lines = body.splitlines(1)
  180.     for line in lines:
  181.         if line.endswith(CRLF):
  182.             line = line[:-2]
  183.         elif line[-1] in CRLF:
  184.             line = line[:-1]
  185.         
  186.         lineno += 1
  187.         encoded_line = ''
  188.         prev = None
  189.         linelen = len(line)
  190.         for j in range(linelen):
  191.             c = line[j]
  192.             prev = c
  193.             if bqre.match(c):
  194.                 c = quote(c)
  195.             elif j + 1 == linelen:
  196.                 if c not in ' \t':
  197.                     encoded_line += c
  198.                 
  199.                 prev = c
  200.                 continue
  201.             
  202.             if len(encoded_line) + len(c) >= maxlinelen:
  203.                 encoded_body += encoded_line + '=' + eol
  204.                 encoded_line = ''
  205.             
  206.             encoded_line += c
  207.         
  208.         if prev and prev in ' \t':
  209.             if lineno + 1 == len(lines):
  210.                 prev = quote(prev)
  211.                 if len(encoded_line) + len(prev) > maxlinelen:
  212.                     encoded_body += encoded_line + '=' + eol + prev
  213.                 else:
  214.                     encoded_body += encoded_line + prev
  215.             else:
  216.                 encoded_body += encoded_line + prev + '=' + eol
  217.             encoded_line = ''
  218.         
  219.         if lines[lineno].endswith(CRLF) or lines[lineno][-1] in CRLF:
  220.             encoded_body += encoded_line + eol
  221.         else:
  222.             encoded_body += encoded_line
  223.         encoded_line = ''
  224.     
  225.     return encoded_body
  226.  
  227. body_encode = encode
  228. encodestring = encode
  229.  
  230. def decode(encoded, eol = NL):
  231.     '''Decode a quoted-printable string.
  232.  
  233.     Lines are separated with eol, which defaults to \\n.
  234.     '''
  235.     if not encoded:
  236.         return encoded
  237.     
  238.     decoded = ''
  239.     for line in encoded.splitlines():
  240.         line = line.rstrip()
  241.         if not line:
  242.             decoded += eol
  243.             continue
  244.         
  245.         i = 0
  246.         n = len(line)
  247.         while i < n:
  248.             c = line[i]
  249.             if c != '=':
  250.                 decoded += c
  251.                 i += 1
  252.             elif i + 1 == n:
  253.                 i += 1
  254.                 continue
  255.             elif i + 2 < n and line[i + 1] in hexdigits and line[i + 2] in hexdigits:
  256.                 decoded += unquote(line[i:i + 3])
  257.                 i += 3
  258.             else:
  259.                 decoded += c
  260.                 i += 1
  261.             if i == n:
  262.                 decoded += eol
  263.                 continue
  264.     
  265.     if not encoded.endswith(eol) and decoded.endswith(eol):
  266.         decoded = decoded[:-1]
  267.     
  268.     return decoded
  269.  
  270. body_decode = decode
  271. decodestring = decode
  272.  
  273. def _unquote_match(match):
  274.     '''Turn a match in the form =AB to the ASCII character with value 0xab'''
  275.     s = match.group(0)
  276.     return unquote(s)
  277.  
  278.  
  279. def header_decode(s):
  280.     """Decode a string encoded with RFC 2045 MIME header `Q' encoding.
  281.  
  282.     This function does not parse a full MIME header value encoded with
  283.     quoted-printable (like =?iso-8895-1?q?Hello_World?=) -- please use
  284.     the high level email.Header class for that functionality.
  285.     """
  286.     s = s.replace('_', ' ')
  287.     return re.sub('=\\w{2}', _unquote_match, s)
  288.  
  289.